5.2Modbus通道管理

提供了Modbus通道的增删改查、查询指定边缘节点下的所有通道、查询指定设备下的所有通道、创建Modbus设备的网关通道配置、查询Modbus设备的网关通道配置等功能。

5.2.1创建Modbus通道

功能描述：新建一个通道，返回新建通道id。

POST  /api/v1/gateway/channels

Query:

Body:

Body example:

{
  "name": "modbuschannel",
  "model": "0",
  "serialPort": "34134134134",
  "baudRate": 1200,
  "dataBits": 8,
  "checkBits": 0,
  "stopBits": 2
}

cURL example:

curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/gateway/channels?accessKeyId={accessKeyId}&signatureNonce=495&signature={signature}&gatewayId=10000801' \
--header 'platform: 3' \
--header 'projectId: {projectId}' \
--header 'Content-Type: application/json' \
--data-raw '{
              "name": "modbuschannel",
              "model": "0",
              "serialPort": "34134134134",
              "baudRate": 1200,
              "dataBits": 8,
              "checkBits": 0,
              "stopBits": 2
            }'

Response data:

Response example:

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": 14,
    "gatewayid": 10000144,
    "name": "api_channel_01",
    "model": 0,
    "serialPort": "/devredfffffffff",
    "baudRate": 300,
    "dataBits": 5,
    "checkBits": 0,
    "stopBits": 1,
    "ip": "",
    "port": 0,
    "created": 1566439063,
    "modified": 0
  }
}

5.2.2修改Modbus通道

功能描述：修改指定通道。

PUT  /api/v1/gateway/channels/{id}

Path:

Body:

Body example:

{
  "name": "modbuschannel"
}

cURL example:

curl --location --request PATCH '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/gateway/channels/110?accessKeyId={accessKeyId}&signatureNonce=495&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}' \
--header 'Content-Type: application/json' \
--data-raw '{
              "name": "modbuschannel"
            }'

Response example:

{
    "success": true,
    "code": 0,
    "msg": "",
    "data": 1
}

5.2.3查询Modbus通道详情

功能描述：根据id查询指定通道，返回该通道的具体信息。

GET  /api/v1/gateway/channels/{id}

Path:

cURL example:

curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/gateway/channels/110?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'

Response data:

Response example:

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": 14,
    "gatewayid": 10000144,
    "name": "api_channel_01",
    "model": 0,
    "serialPort": "/devredfffffffff",
    "baudRate": 300,
    "dataBits": 5,
    "checkBits": 0,
    "stopBits": 1,
    "ip": "",
    "port": 0,
    "created": 1566439063,
    "modified": 0
  }
}

5.2.4查询边缘节点下的所有通道

功能描述：查询指定边缘节点下的所有通道，返回该通道信息列表。

GET  /api/v1/gateway/channels

Query:

cURL example:

curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/gateway/channels?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}&gatewayId=10000807' \
--header 'platform: 3' \
--header 'projectId: {projectId}'

Response data:

Response data data的子对象结构体:

Response example:

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 14,
      "gatewayid": 10000144,
      "name": "api_channel_01",
      "model": 0,
      "serialPort": "/dev",
      "baudRate": 300,
      "dataBits": 5,
      "checkBits": 0,
      "stopBits": 2,
      "ip": "",
      "port": 0,
      "created": 1566439063,
      "modified": 1566440081
    }
  ]
}

5.2.5删除Modbus通道

功能描述：删除指定通道。

DELETE  /api/v1/gateway/channels/{id}

Path:

cURL example:

curl --location --request DELETE '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/gateway/channels/110?accessKeyId={accessKeyId}&signatureNonce=529&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'

Response example:

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 1
}

5.2.6根据设备ID查询Modbus通道列表

功能描述：查询指定设备下的所有通道，返回该通道信息列表。

GET  /api/v1/device/4/channel/device/{deviceId}

Path:

cURL example:

curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/device/4/channel/device/10000807?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}'

Response data:

Response data data的子对象结构体:

Response example:

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 14,
      "gatewayid": 10000144,
      "name": "api_channel_01",
      "model": 0,
      "serialPort": "/dev",
      "baudRate": 300,
      "dataBits": 5,
      "checkBits": 0,
      "stopBits": 2,
      "ip": "",
      "port": 0,
      "created": 1566439063,
      "modified": 1566440081
    }
  ]
}

5.2.7创建Modbus设备的边缘节点通道配置

功能描述：为Modbus设备创建一个网关通道配置，根据此配置可以实现该设备数据的上传和下发。

注意：此接口多次调用会覆盖旧的Modbus设备网关通道配置。

POST  /api/v1/devices/modbus/channel-config/gateway

Body:

Body example:

{
    "id": 101,
    "channelId": 100,
    "modbusAddress": 10,
    "collectTime": 11
}

cURL example:

curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/modbus/channel-config/gateway?accessKeyId={accessKeyId}&signatureNonce=495&signature={signature}' \
--header 'platform: 3' \
--header 'projectId: {projectId}' \
--header 'Content-Type: application/json' \
--data-raw '{
                "id": 101,
                "channelId": 100,
                "modbusAddress": 10,
                "collectTime": 11
            }'

Response example:

{
    "success": true,
    "code": 0,
    "msg": "",
    "data": 1
}

5.2.8获取Modbus设备的边缘节点通道配置

功能描述：获取Modbus设备的网关通道配置。

GET  /api/v1/devices/modbus/channel-config

Query:

cURL example:

curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/devices/modbus/channel-config?accessKeyId={accessKeyId}&signatureNonce=166&signature={signature}&id=10000807' \
--header 'platform: 3' \
--header 'projectId: {projectId}'

Response data:

Response example:

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": 10000196,
    "channelId": 16,
    "modbusAddress": 1,
    "collectTime": 10
  }
}